widgets.brease.TextInput

Widget Description

short: Texteingabe
de: Ermöglicht dem Benutzer einen Text einzugeben
en: Enables the user to enter a text

Properties

name description category type defaultValue bindable readOnly required localizable editableBinding projectable cssProp (has no setter and getter in JS) groupRefId groupOrder nodeRefId (for linking node and value) deprecated typeRefId (for StyleReference) subtype (for MpComIdentReference)
draggable Make widget draggable. Behavior Boolean false false false false false false true
ellipsis If true, overflow of text is symbolized with an ellipsis. Behavior Boolean false false false false false false true
enable Initial option to enable widget. Behavior Boolean true true false false false false true
inputRestriction Indicates the set of characters that a user can enter into the TextInput If not defined (=default), there is no restriction. Behavior RegEx false false false true false true
keyboard Determines if internal soft keyboard should open Behavior Boolean true false false false false false true
maxLength The maxLength attribute specifies the maximum number of characters allowed in the TextInput If maxLength is less than 0, there is no restriction. Behavior Integer -1 false false false false false true
permissionOperate restricts operability to users, which have given roles Accessibility RoleCollection no defaultValue
defined		 false false false false false true
permissionView restricts visibility to users, which have given roles Accessibility RoleCollection no defaultValue
defined		 false false false false false true
placeholder Specifies a short hint that describes the expected value of the input field Behavior String false false false true false true
style reference to a style for this widget type Appearance StyleReference default true false false false false true
submitOnChange Determines if changes, triggered by user input, should be sent immediately to the server. Behavior Boolean true false false false false false true
tabIndex sets if a widget should have autofocus enabled (0), the order of the focus (>0), or if autofocus should be disabled (-1) Behavior Integer 0 false false false false false true
tooltip reference to a tooltip for a widget Appearance String false false false true false true
value Value displayed by the widget Data String true false false false true true
visible change visibility Behavior Boolean true true false false false false true
maxHeight maximum outer height of widget Size 0 false false false true true
minHeight minimum outer height of widget Size 0 false false false true true
maxWidth maximum outer width of widget Size 0 false false false true true
minWidth minimum outer width of widget Size 0 false false false true true
zIndex The zIndex property specifies the z-order of a widget and its childs.
When widgets overlap, z-order determines which one covers the other. A widget with a larger zIndex generally covers a widget with a lower one.
The zIndex must be unique within a content.
 UInteger no defaultValue
defined		 false false true true true
left absolute position measured from left boundary of parent container Integer no defaultValue
defined		 false false false true true
top absolute position measured from top boundary of parent container Integer no defaultValue
defined		 false false false true true
height outer height of widget AutoSize 30 false false false true true
width outer width of widget AutoSize 100 false false false true true

Styleable Properties

name type description defaultValue
borderWidth PixelValCollection

Sets the border width of the widget. For further information, please see its type

 2px 6px 2px 2px
activeBorderWidth PixelValCollection

Sets the border width of the widget while writing in. For further information, please see its type

 2px 6px 2px 2px
disabledBorderWidth PixelValCollection

Sets the border width of the widget when disbaled. For further information, please see its type

 2px 6px 2px 2px
cornerRadius PixelValCollection

Sets the radius of the widget rounded corners. For further information, please see its type

 2px
backColor Color

Sets the background color of the widget

 #F7F7FF
disabledBackColor Color

Sets the background color of the widget when disabled

 #F1F1F1
backGroundGradient Gradient

Sets the background color of the widget as a gradient. For further information, please see CSS Gradients
disabledBackGroundGradient Gradient

Sets the background color of the widget when disabled as a gradient. For further information, please see CSS Gradients property
borderColor ColorCollection

Sets the border color of the widget. For further information, please see its type

 #555555
disabledBorderColor ColorCollection

Sets the border color of the widget when disabled. For further information, please see its type

 #C8C8C8
borderStyle BorderStyle

Style of the border of the widget. For further information, please see its type

 solid
textColor Color

Sets the color of the displayed text

 #333333
placeholderTextColor Color

Sets the color of the displayed placeholder

 #C8C8C8
disabledTextColor Color

Sets the color of the displayed text when the widget is disabled

 #C8C8C8
activeBorderColor ColorCollection

Sets the border color of the widget while writing in. For further information, please see its type

 #FF8800
activeBackColor Color

Sets the background color of the widget while writing in

 #F7F7FF
activeTextColor Color

Sets the color of the displayed text while writing

 #333333
textAlign brease.enum.TextAlign

Sets the alignment of the text. For further information, please see its type

 right
opacity Opacity

Sets the opacity of the widget

 1
fontName FontName

Sets the font name of the displayed text

 Arial
fontSize PixelVal

Sets the font size of the displayed text in pixel

 21px
bold Boolean

If true, it sets the font style to bold

 false
rotation Rotation

Sets the rotation of the widget with respect to its center. Positive values for clockwise direction

 0deg
italic Boolean

If true, it sets the font style to italic

 false
shadow Shadow

Sets the shadow effect of the widget. For further information, please see its type

 none
padding Padding

Sets a space around the displayed text. For further information, please see its type

 0 15px 0 15px
margin Margin

Sets a space around the widget. For further information, please see its type

 0px

Events

name description arguments
Click Fired when element is clicked on.
  • origin: String

    id of widget that triggered this event

  • horizontalPos: String

    horizontal position of click in pixel i.e '10px'

  • verticalPos: String

    vertical position of click in pixel i.e '10px'

DisabledClick Fired when disabled element is clicked on.
  • origin: String

    id of widget that triggered this event

  • hasPermission: Boolean

    defines if the state is caused due to missing roles of the current user

  • horizontalPos: String

    horizontal position of click in pixel i.e '10px'

  • verticalPos: String

    vertical position of click in pixel i.e '10px'

EnableChanged Fired when operability of the widget changes.
  • value: Boolean

    operability

FocusIn Fired when the widgets gets focus
FocusOut Fired when the widgets lost focus
OnDragEnd Fired when element has OnDragEnd.
  • contentId: String

    content id of the widget where the drag operation has ended

  • widgetId: String

    id of the widget where the drag operation has ended

OnDragEnter Fired when element has onDragEnter.
  • contentId: String

    content id of the widget that has been entering the droppable widget

  • widgetId: String

    id of the widget that has been entering the droppable widget

OnDragLeave Fired when element has OnDragLeave.
  • contentId: String

    content id of the widget that has been leaving the droppable widget

  • widgetId: String

    id of the widget that has been leaving the droppable widget

OnDragStart Fired when element has OnDragStart.
  • contentId: String

    content id of the widget where the drag operation has been started

  • widgetId: String

    id of the widget where the drag operation has been started

OnDrop Fired when element has OnDrop.
  • contentId: String

    content id of the widget that has been dropped on the droppable widget

  • widgetId: String

    id of the widget that has been dropped on the droppable widget

ValueChanged Fired when index changes.
  • value: String

VisibleChanged Fired when the visibility of the widget changes.
  • value: Boolean

    visibility

Actions

name description arguments result
Focus Sets focus on the widget element, if it can be focused and keyboardOperation=true
GetValue Gets the visible text The current value
SetEnable Sets the state of property «enable»
  • value: Boolean

SetStyle
  • value: StyleReference

SetValue sets the visible text
  • value: String

    The new value

SetVisible Sets the state of property «visible»
  • value: Boolean

ShowTooltip
SubmitChange Send value to the server, if binding for this widget exists. Usage of this method will only make sense, if submitOnChange=false, as otherwise changes are submitted automatically.